home *** CD-ROM | disk | FTP | other *** search
/ PD Collection CD 1 / PD Collection CD 1.iso / textual / tex / files / !MISpell / !Help < prev    next >
Encoding:
Text File  |  1990-08-07  |  14.4 KB  |  358 lines
  1.  
  2. ISPELL(local)   DOMAIN/IX Reference Manual (MIT)    ISPELL(local)
  3.  
  4.  
  5. AUTHOR
  6.  
  7.      This version by Graham Toal <gtoal@uk.ac.ed>
  8.  
  9.      MISpell is my hack of ispell; I've renamed it so that ispell
  10.      afficionadoes don't get upset when they see how much it has
  11.      changed; however full credit for this interface goes to the
  12.      original authors, named at the foot of this help file.  I merely
  13.      accept responsibility for the new checking code.  (But not in
  14.      the legal sense; use it at your own risk)
  15.  
  16.  
  17. NAME
  18.  
  19.      !mispell - Correct spelling for a file
  20.  
  21.  
  22. SYNOPSIS
  23.  
  24.      Drop a file on the !MISpell icon.  Press ? inside the program
  25.      for on-line help.  Your corrected file will be modified at the
  26.      end of the session unless you exit with Escape or X.
  27.  
  28.      Note that although this comes free with my TeX distribution, it
  29.      doesn't support ignore TeX formatting commands.  It will some day.
  30.  
  31. DESCRIPTION
  32.  
  33.      The description below is stolen directly from the Unix(tm) version;
  34.      please read between the lines for what happens on the Archimedes --
  35.      a lot of the options below will not be implemented.
  36.  
  37.      Note that the normal Wimp command window isn't big enough for
  38.      this program; my normal release of this includes a new Templates
  39.      file which enlarges that window quite considerably.
  40.  
  41.      Ispell is fashioned after the spell program from ITS (called
  42.      ispell on Twenex systems.)  The most common usage is "ispell
  43.      filename".  In this case, ispell will display each word
  44.      which does not appear in the dictionary, and allow you to
  45.      change it.  If there are "near misses" in the dictionary
  46.      (words which differ by only a single letter, a missing or
  47.      extra letter, or a pair of transposed letters), then they
  48.      are also displayed.  If you think the word is correct as it
  49.      stands, you can type either "Space" to accept it this one
  50.      time, or "I" to accept it and put it in your private dic-
  51.      tionary.  If one of the near misses is the word you want,
  52.      type the corresponding number.  (If there are more than 10
  53.      choices, you may have to type a carriage return to complete
  54.      a single-digit number).  Finally, if none of these choices
  55.      is right, you can type "R" and you will be prompted for a
  56.      replacement word.  If you want to see a list of words that
  57.      might be close using wildcard characters, type "L" to lookup
  58.      a word in the system dictionary.
  59.  
  60.      When a misspelled word is found, it is printed at the top of
  61.      the screen.  Any near misses will be printed on the follow-
  62.      ing lines, and finally, two lines containing the word are
  63.      printed at the bottom of the screen.  If your terminal can
  64.      type in reverse video, the word itself is highlighted.
  65.  
  66.      The -v option causes ispell to print its current version
  67.      identification on the standard output and exit.
  68.  
  69.      The -l or "list" option to ispell is used to produce a list
  70.      of misspelled words from the standard input.
  71.  
  72.      The -a option is intended to be used from other programs
  73.      through a pipe.  In this mode, ispell expects the standard
  74.      input to consist of lines containing single words.  Each
  75.      word is read, and a single line is written to the standard
  76.      output.  If the word was found in the main dictionary, or
  77.  
  78.  
  79.  
  80. Printed 7/9/87                                           ISPELL-1
  81.  
  82. ISPELL(local)   DOMAIN/IX Reference Manual (MIT)    ISPELL(local)
  83.  
  84.  
  85.  
  86.      your personal dictionary, then the line contains only a '*'.
  87.      If the word was found through suffix removal, then the line
  88.      contains a '+', a space, and the root word.  If the word is
  89.      not in the dictionary, but there are near misses, then the
  90.      line contains an '&', a space, and a list of the near misses
  91.      separated by spaces.  Also, each near miss is capitalized
  92.      the same as the input word if unless such capitalization is
  93.      illegal; in the latter case each near miss is capitalized
  94.      correctly according to the dictionary.  Finally, if the word
  95.      neither appears in the dictionary, and there are no near
  96.      misses, then the line contains only a '#'.  This mode is
  97.      also suitable for interactive use when you want to figure
  98.      out the spelling of a single word.  (These characters are
  99.      the same as the codes that the real spell program uses.)
  100.  
  101.      The -A option works just like -a, except that if a line
  102.      begins with the string "&Include_File&", the rest of the
  103.      line is taken as the name of a file to read for further
  104.      words.  Input returns to the original file when the include
  105.      file is exhausted.  Inclusion may be nested up to five deep.
  106.      The key string may be changed with the environment variable
  107.      INCLUDE_STRING (the ampersands, if any, must be included).
  108.  
  109.      When in the -a mode, ispell will also accept lines of single
  110.      words prefixed with either a '*' or a '@'.  A line starting
  111.      with '*' tells ispell to insert the word into the user's
  112.      dictionary (similar to the I command).  A line starting with
  113.      '@' causes ispell to accept this word in the future (similar
  114.      to the A command).
  115.  
  116.      The -x option causes ispell to remove the .bak file that it
  117.      normally leaves.  The .bak file contains the pre-corrected
  118.      text.  If there are file opening / writing errors, the .bak
  119.      file may be left for recovery purposes even with the -x
  120.      option.
  121.  
  122.      The -S option suppresses ispell's normal behavior of sorting
  123.      the list of possible replacement words.  Some people may
  124.      prefer this, since it somewhat enhances the probability that
  125.      the correct word will be low-numbered.
  126.  
  127.      The -t option selects TeX/LaTeX input mode.  TeX/LaTeX mode
  128.      is also automatically selected if an input file has the
  129.      extension ".tex".  In this mode, whenever a backslash ("\")
  130.      is found, ispell will skip to the next whitespace.  Thus,
  131.      for example, given
  132.           \chapter {This is a Ckapter} \cite{SCH86}
  133.      will find "Ckapter" but will not look for SCH.  The -t
  134.      option does not recognise the TeX comment character "%".
  135.  
  136.      The -d option is used to specify an alternate hashed dic-
  137.      tionary file, other than the default.  If the filename does
  138.  
  139.  
  140.  
  141. ISPELL-2                                           Printed 7/9/87
  142.  
  143. ISPELL(local)   DOMAIN/IX Reference Manual (MIT)    ISPELL(local)
  144.  
  145.  
  146.  
  147.      not begin with a "/", the library directory for the default
  148.      dictionary file is prefixed.  This is useful to allow dic-
  149.      tionaries which prefer alternate British spellings ("cen-
  150.      tre", "tyre", etc), or add lists of special-purpose jargon
  151.      and acronyms for subclasses of documents.  There are some
  152.      shortcomings in attempting to provide foreign-language dic-
  153.      tionaries, but something like "-d french" could be made to
  154.      work somewhat.  The -d option may specify /dev/null, in
  155.      which case the dictionary is limited to the personal one.
  156.      This may be useful for certain private dictionaries.
  157.  
  158.      The -p option is used to specify an alternate personal dic-
  159.      tionary file.  If the file name does not begin with "/",
  160.      $HOME is prefixed.  Also, the shell variable WORDLIST may be
  161.      set, which renames the personal dictionary in the same
  162.      manner.  The command line overrides WORDLIST setting.  If
  163.      neither is present "~/.ispell_words" is used.
  164.  
  165.      The -w option may be used to specify characters other than
  166.      alphabetics which may also appear in words.  For instance,
  167.      -w "&" will allow "AT&T" to be picked up.  Underscores are
  168.      useful in many technical documents.  There is an admittedly
  169.      crude provision in this option for 8-bit international char-
  170.      acters.  Non-printing characters may be specified in the
  171.      usual way by inserting a backslash followed by the octal
  172.      character code; e.g., "\014" for a form feed.  Alterna-
  173.      tively, if "n" appears in the character string, the (up to)
  174.      three characters following are a DECIMAL code 0 - 255, for
  175.      the character.  For example, to include bells and form feeds
  176.      in your words (an admittedly silly thing to do, but aren't
  177.      most pedagogical examples):
  178.  
  179.      n007n012
  180.  
  181.      Numeric digits other than the three following "n" are simply
  182.      numeric characters.  Use of "n" does not conflict with any-
  183.      thing because actual alphabetics have no meaning - alphabet-
  184.      ics are already accepted.  Ispell will typically be used
  185.      with input from a file, meaning that preserving parity for
  186.      possible 8 bit characters from the input text is OK.  If you
  187.      specify the -l option, and actually type text from the ter-
  188.      minal, this may create problems if your stty settings
  189.      preserve parity.
  190.  
  191.      The -c option is primarily intended for use by the munchlist
  192.      shell script.  In this mode, a list of words is read from
  193.      the standard input.  For each word, a list of possible root
  194.      words and suffixes will be written to the standard output.
  195.      Some of the root words will be illegal and must be filtered
  196.      from the output by other means; the munchlist script does
  197.      this.  As an example, the command "echo BOTHER | ispell -c"
  198.      produces:
  199.  
  200.  
  201.  
  202. Printed 7/9/87                                           ISPELL-3
  203.  
  204. ISPELL(local)   DOMAIN/IX Reference Manual (MIT)    ISPELL(local)
  205.  
  206.  
  207.  
  208.           BOTH
  209.           BOTHE/R
  210.           BOTH/R
  211.  
  212.      Unless it has been installed without the feature by your
  213.      system administrator, ispell is aware of the correct capi-
  214.      talizations of words in the dictionary and in your personal
  215.      dictionary.  As well as recognising words that must be capi-
  216.      talized (e.g., George) and words that must be all-capitals
  217.      (e.g., NASA), it can also handle words with "unusual" capi-
  218.      talization (e.g., "ITCorp" or "TeX").  If a word is capital-
  219.      ized incorrectly, the list of possibilities will include all
  220.      acceptable capitalisations.  (More than one capitalization
  221.      may be acceptable; for example, my dictionary lists both
  222.      "ITCorp" and "ITcorp".) Normally, this feature will not
  223.      cause you surprises, but there is one circumstance you need
  224.      to be aware of.  If you add a word to your dictionary that
  225.      is at the beginning of a sentence (e.g., the first word of
  226.      this paragraph if "unless" were not in the dictionary), it
  227.      will be marked as "capitalization required".  A subsequent
  228.      usage of this word without capitalization (e.g., the quoted
  229.      word in the previous sentence), ispell will object and sug-
  230.      gest the capitalized version.  You must then compare the
  231.      actual spellings by eye, and then type "I" to add the un-
  232.      capitalized variant to your personal dictionary.
  233.  
  234.      The rules for capitalization are as follows:
  235.  
  236.      (1)  Any word may appear in all capitals, as in headings.
  237.  
  238.      (2)  Any word that is in the dictionary in all-lowercase
  239.           form may appear either in lowercase or capitalized (as
  240.           at the beginning of a sentence).
  241.  
  242.      (3)  Any word that has "funny" capitalization (i.e., it con-
  243.           tains both cases and there is an uppercase character
  244.           besides the first) must appear exactly as in the dic-
  245.           tionary, except as permitted by rule (1).  If the word
  246.           is acceptable in all-lowercase, it must appear thus in
  247.           a dictionary entry.
  248.  
  249.      The munchlist shell script is used to reduce the size of
  250.      dictionary files, primarily personal dictionary files.  It
  251.      is also capable of combining dictionaries from various
  252.      sources.  The given files are read (standard input if no
  253.      arguments are given), reduced to a minimal set of roots and
  254.      suffixes that will match the same list of words, and written
  255.      to standard output.
  256.  
  257.      Normally, words that are in the default dictionary are
  258.      removed by munchlist during processing.  If the list is to
  259.      be used with a different dictionary, the -d option can be
  260.  
  261.  
  262.  
  263. ISPELL-4                                           Printed 7/9/87
  264.  
  265. ISPELL(local)   DOMAIN/IX Reference Manual (MIT)    ISPELL(local)
  266.  
  267.  
  268.  
  269.      used to specify an alternate (hashed) dictionary file con-
  270.      taining words to be removed from the output list.  If a dic-
  271.      tionary file of /dev/null is specified, no words will be
  272.      removed from the output; this is useful when munching the
  273.      primary dictionary file.
  274.  
  275.      The -w option is passed on to ispell.  The -e ("efficient")
  276.      option causes the script to use a slower algorithm that uses
  277.      somewhat less space in TMPDIR (normally /usr/tmp).
  278.  
  279.      The isexpand shell script is used to expand the various suf-
  280.      fix flags in an ispell word list.  This script can be used
  281.      when looking words up in the dictionary, or to verify that a
  282.      particular suffix flag actually produces the expected
  283.      result.
  284.  
  285.      It is possible to install ispell in such a way as to only
  286.      support ASCII range text if desired.
  287.  
  288. ENVIRONMENT
  289.      WORDLIST       Personal dictionary file name
  290.      INCLUDE_STRING      Code for file inclusion under the -A
  291.      option
  292.      TMPDIR         Directory used for some of munchlist's tem-
  293.      porary files
  294.  
  295. FILES
  296.      <MISpell$Dir>.dict-dwg   master dictionary in compresed format
  297.      <MISpell$Dir>.dict-txt   user's private dictionary
  298.  
  299. BUGS
  300.      Numerous, but not yet documented.  The Unix bugs have been
  301.      exchanged for a different set :-)
  302.  
  303.      The source of this command will eventually be released to
  304.      eunet.micro.acorn; you will also need my general-purpose
  305.      spelling kernel from alt.sources, hopefully soon to be
  306.      comp.sources.misc
  307.  
  308.  
  309. Printed 7/9/87                                           ISPELL-5
  310.  
  311. ISPELL(local)   DOMAIN/IX Reference Manual (MIT)    ISPELL(local)
  312.  
  313.  
  314.  
  315.      While alternate dictionaries for foreign languages could be
  316.      defined, and the international characters included in words,
  317.      rules concerning word endings / pluralization accommodate
  318.      English only.
  319.  
  320.      When the -x flag is specified, ispell will unlink any exist-
  321.      ing .bak file.
  322.  
  323. AUTHOR
  324.      Pace Willisson (pace@mit-vax)
  325.      Collected, revised, and enhanced for the Usenet by Walt
  326.      Buehring.
  327.      Further enhanced and debugged by Isaac Balbin, Stewart Cla-
  328.      men, Mark Davies, Steve Dum, Gary Johnson, Don Kark, Steve
  329.      Kelem, Jim Knutson, Geoff Kuenning, Evan Marcus, Dave Mason,
  330.      Rob McMahon, Bob McQueer, David Neves, Joe Orost, Israel
  331.      Pinkas, Gary Puckering, Bill Randle, Marc Ries, Rich Salz,
  332.      Greg Schaffer, Joel Shprentz, George Sipe, Perry Smith, Graham
  333.      Toal, Stefan Taxhet, Andrew Vignaux, Johan Widen, James Woods,
  334.      and Ken Yap.
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357. ISPELL-6                                           Printed 7/9/87
  358.